JAMS REST API Web Service
PutFolder_PutFolder

Resource Path: /JAMS/APIHelp/docs/V6/api/folder

Uri: http://left/JAMS/APIHelp/docs/V6/api/folder

Description
Updates an existing folder definition
Request

The request body is of type Folder.

The folder definition

Overview

Folder
acl : ACL
genericACL : Array[ACE]
identifier : string
flags : string
access : string
batchQueueName : string
batchQueueID : integer
description : string
homeDirectory : string
keepLogs : string
lastChangedBy : string
lastChangeUTC : string
logLocation : string
notifyEmail : string
notifyJobID : integer
notifyJobName : string
notifyJobNameIsRelative : boolean
timestampLogs : string
userID : integer
notifyOther : string
printLocation : string
printQueue : string
parameters : Array[Param]
allowEntry : boolean
dataType : string
defaultFormat : string
defaultValue : string
helpText : string
hide : boolean
jobID : integer
lastChangeUTC : string
length : integer
mustFill : boolean
parameterOrigin : string
paramName : string
prompt : string
required : boolean
sequence : integer
uppercase : boolean
validationData : string
validationType : string
variableID : integer
variableName : string
variableNameIsRelative : boolean
alerts : Array[AlertReq]
alertID : integer
alertName : string
isInherited : boolean
schedulingPriorityModifier : integer
notifyUsers : string
recoveryInstructions : string
retainOption : string
retainTime : string
runawayElapsedPer : integer
templateLibrary : string
shortElapsedPer : integer
shortSeverity : string
stalledTime : string
folderID : integer
folderName : string
name : string
parentFolderID : integer
parentFolderName : string
userName : string
requirements : Array[ResReq]
autoRelease : boolean
lastChangeUTC : string
netQuantityRequired : integer
quantityInherited : integer
quantityRequired : integer
resourceID : integer
resourceName : string
retainOnFailure : boolean
searchPath : string
Response

The response body is of type Folder.

OK

Overview

Folder
acl : ACL
genericACL : Array[ACE]
identifier : string
flags : string
access : string
batchQueueName : string
batchQueueID : integer
description : string
homeDirectory : string
keepLogs : string
lastChangedBy : string
lastChangeUTC : string
logLocation : string
notifyEmail : string
notifyJobID : integer
notifyJobName : string
notifyJobNameIsRelative : boolean
timestampLogs : string
userID : integer
notifyOther : string
printLocation : string
printQueue : string
parameters : Array[Param]
allowEntry : boolean
dataType : string
defaultFormat : string
defaultValue : string
helpText : string
hide : boolean
jobID : integer
lastChangeUTC : string
length : integer
mustFill : boolean
parameterOrigin : string
paramName : string
prompt : string
required : boolean
sequence : integer
uppercase : boolean
validationData : string
validationType : string
variableID : integer
variableName : string
variableNameIsRelative : boolean
alerts : Array[AlertReq]
alertID : integer
alertName : string
isInherited : boolean
schedulingPriorityModifier : integer
notifyUsers : string
recoveryInstructions : string
retainOption : string
retainTime : string
runawayElapsedPer : integer
templateLibrary : string
shortElapsedPer : integer
shortSeverity : string
stalledTime : string
folderID : integer
folderName : string
name : string
parentFolderID : integer
parentFolderName : string
userName : string
requirements : Array[ResReq]
autoRelease : boolean
lastChangeUTC : string
netQuantityRequired : integer
quantityInherited : integer
quantityRequired : integer
resourceID : integer
resourceName : string
retainOnFailure : boolean
searchPath : string
See Also
All Operations Resource GroupJAMS REST API Web Service

 

 


© 2017 All Rights Reserved.

Send comments on this topic.